home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / gcc / ixemsdk.lha / man / cat3 / resolver.0 < prev    next >
Text File  |  1996-09-02  |  9KB  |  147 lines
  1.  
  2. RESOLVER(3)                UNIX Programmer's Manual                RESOLVER(3)
  3.  
  4. NNAAMMEE
  5.      rreess__qquueerryy, rreess__sseeaarrcchh, rreess__mmkkqquueerryy, rreess__sseenndd, rreess__iinniitt, ddnn__ccoommpp,
  6.      ddnn__eexxppaanndd - resolver routines
  7.  
  8. SSYYNNOOPPSSIISS
  9.      ##iinncclluuddee <<ssyyss//ttyyppeess..hh>>
  10.      ##iinncclluuddee <<nneettiinneett//iinn..hh>>
  11.      ##iinncclluuddee <<aarrppaa//nnaammeesseerr..hh>>
  12.      ##iinncclluuddee <<rreessoollvv..hh>>
  13.  
  14.      rreess__qquueerryy(_c_h_a_r _*_d_n_a_m_e, _i_n_t _c_l_a_s_s, _i_n_t _t_y_p_e, _u___c_h_a_r _*_a_n_s_w_e_r, _i_n_t _a_n_s_l_e_n)
  15.  
  16.      rreess__sseeaarrcchh(_c_h_a_r _*_d_n_a_m_e, _i_n_t _c_l_a_s_s, _i_n_t _t_y_p_e, _u___c_h_a_r _*_a_n_s_w_e_r, _i_n_t _a_n_s_l_e_n)
  17.  
  18.      rreess__mmkkqquueerryy(_i_n_t _o_p, _c_h_a_r _*_d_n_a_m_e, _i_n_t _c_l_a_s_s, _i_n_t _t_y_p_e, _c_h_a_r _*_d_a_t_a,
  19.              _i_n_t _d_a_t_a_l_e_n, _s_t_r_u_c_t _r_r_e_c _*_n_e_w_r_r, _c_h_a_r _*_b_u_f, _i_n_t _b_u_f_l_e_n)
  20.  
  21.      rreess__sseenndd(_c_h_a_r _*_m_s_g, _i_n_t _m_s_g_l_e_n, _c_h_a_r _*_a_n_s_w_e_r, _i_n_t _a_n_s_l_e_n)
  22.  
  23.      rreess__iinniitt()
  24.  
  25.      ddnn__ccoommpp(_c_h_a_r _*_e_x_p___d_n, _c_h_a_r _*_c_o_m_p___d_n, _i_n_t _l_e_n_g_t_h, _c_h_a_r _*_*_d_n_p_t_r_s,
  26.              _c_h_a_r _*_*_l_a_s_t_d_n_p_t_r)
  27.  
  28.      ddnn__eexxppaanndd(_u___c_h_a_r _*_m_s_g, _u___c_h_a_r _*_e_o_m_o_r_i_g, _u___c_h_a_r _*_c_o_m_p___d_n, _u___c_h_a_r _*_e_x_p___d_n,
  29.              _i_n_t _l_e_n_g_t_h)
  30.  
  31. DDEESSCCRRIIPPTTIIOONN
  32.      These routines are used for making, sending and interpreting query and
  33.      reply messages with Internet domain name servers.
  34.  
  35.      Global configuration and state information that is used by the resolver
  36.      routines is kept in the structure ___r_e_s. Most of the values have reason-
  37.      able defaults and can be ignored.  Options stored in ___r_e_s_._o_p_t_i_o_n_s are de-
  38.      fined in _r_e_s_o_l_v_._h and are as follows.  Options are stored as a simple bit
  39.      mask containing the bitwise ``or'' of the options enabled.
  40.  
  41.      RES_INIT      True if the initial name server address and default domain
  42.                    name are initialized (i.e., rreess__iinniitt() has been called).
  43.  
  44.      RES_DEBUG     Print debugging messages.
  45.  
  46.      RES_AAONLY    Accept authoritative answers only.  With this option,
  47.                    rreess__sseenndd() should continue until it finds an authoritative
  48.                    answer or finds an error.  Currently this is not implement-
  49.                    ed.
  50.  
  51.      RES_USEVC     Use TCP connections for queries instead of UDP datagrams.
  52.  
  53.      RES_STAYOPEN  Used with RES_USEVC to keep the TCP connection open between
  54.                    queries.  This is useful only in programs that regularly do
  55.                    many queries.  UDP should be the normal mode used.
  56.  
  57.      RES_IGNTC     Unused currently (ignore truncation errors, i.e., don't
  58.                    retry with TCP).
  59.  
  60.      RES_RECURSE   Set the recursion-desired bit in queries.  This is the de-
  61.                    fault.  (rreess__sseenndd() does not do iterative queries and ex-
  62.                    pects the name server to handle recursion.)
  63.  
  64.      RES_DEFNAMES  If set, rreess__sseeaarrcchh() will append the default domain name to
  65.                    single-component names (those that do not contain a dot).
  66.  
  67.                    This option is enabled by default.
  68.  
  69.      RES_DNSRCH    If this option is set, rreess__sseeaarrcchh() will search for host
  70.                    names in the current domain and in parent domains; see
  71.                    hostname(7).  This is used by the standard host lookup rou-
  72.                    tine gethostbyname(3).  This option is enabled by default.
  73.  
  74.      The rreess__iinniitt() routine reads the configuration file (if any; see
  75.      resolv.conf(5))  to get the default domain name, search list and the In-
  76.      ternet address of the local name server(s).  If no server is configured,
  77.      the host running the resolver is tried.  The current domain name is de-
  78.      fined by the hostname if not specified in the configuration file; it can
  79.      be overridden by the environment variable LOCALDOMAIN. This environment
  80.      variable may contain several blank-separated tokens if you wish to over-
  81.      ride the _s_e_a_r_c_h _l_i_s_t on a per-process basis.  This is similar to the
  82.      _s_e_a_r_c_h command in the configuration file.  Another environment variable
  83.      RES_OPTIONS can be set to override certain internal resolver options
  84.      which are otherwise set by changing fields in the ___r_e_s structure or are
  85.      inherited from the configuration file's _o_p_t_i_o_n_s command.  The syntax of
  86.      the RES_OPTIONS environment variable is explained in resolv.conf(5).
  87.      Initialization normally occurs on the first call to one of the following
  88.      routines.
  89.  
  90.      The rreess__qquueerryy() function provides an interface to the server query mecha-
  91.      nism.  It constructs a query, sends it to the local server, awaits a re-
  92.      sponse, and makes preliminary checks on the reply.  The query requests
  93.      information of the specified _t_y_p_e and _c_l_a_s_s for the specified fully-
  94.      qualified domain name _d_n_a_m_e. The reply message is left in the _a_n_s_w_e_r
  95.      buffer with length _a_n_s_l_e_n supplied by the caller.
  96.  
  97.      The rreess__sseeaarrcchh() routine makes a query and awaits a response like
  98.      rreess__qquueerryy(), but in addition, it implements the default and search rules
  99.      controlled by the RES_DEFNAMES and RES_DNSRCH options.  It returns the
  100.      first successful reply.
  101.  
  102.      The remaining routines are lower-level routines used by rreess__qquueerryy().  The
  103.      rreess__mmkkqquueerryy() function constructs a standard query message and places it
  104.      in _b_u_f. It returns the size of the query, or -1 if the query is larger
  105.      than _b_u_f_l_e_n. The query type _o_p is usually QUERY, but can be any of the
  106.      query types defined in <_a_r_p_a_/_n_a_m_e_s_e_r_._h>. The domain name for the query is
  107.      given by _d_n_a_m_e. _N_e_w_r_r is currently unused but is intended for making up-
  108.      date messages.
  109.  
  110.      The rreess__sseenndd() routine sends a pre-formatted query and returns an answer.
  111.      It will call rreess__iinniitt() if RES_INIT is not set, send the query to the lo-
  112.      cal name server, and handle timeouts and retries.  The length of the re-
  113.      ply message is returned, or -1 if there were errors.
  114.  
  115.      The ddnn__ccoommpp() function compresses the domain name _e_x_p___d_n and stores it in
  116.      _c_o_m_p___d_n. The size of the compressed name is returned or -1 if there were
  117.      errors.  The size of the array pointed to by _c_o_m_p___d_n is given by _l_e_n_g_t_h.
  118.      The compression uses an array of pointers _d_n_p_t_r_s to previously-compressed
  119.      names in the current message.  The first pointer points to to the begin-
  120.      ning of the message and the list ends with NULL. The limit to the array
  121.      is specified by _l_a_s_t_d_n_p_t_r. A side effect of ddnn__ccoommpp() is to update the
  122.      list of pointers for labels inserted into the message as the name is com-
  123.      pressed.  If _d_n_p_t_r is NULL, names are not compressed. If _l_a_s_t_d_n_p_t_r is
  124.      NULL, the list of labels is not updated.
  125.  
  126.      The ddnn__eexxppaanndd() entry expands the compressed domain name _c_o_m_p___d_n to a
  127.      full domain name The compressed name is contained in a query or reply
  128.      message; _m_s_g is a pointer to the beginning of the message.  The uncom-
  129.      pressed name is placed in the buffer indicated by _e_x_p___d_n which is of size
  130.      _l_e_n_g_t_h. The size of compressed name is returned or -1 if there was an er-
  131.      ror.
  132.  
  133. FFIILLEESS
  134.      /etc/resolv.conf The configuration file see resolv.conf(5).
  135.  
  136. SSEEEE AALLSSOO
  137.      gethostbyname(3),  named(8),  resolv.conf(5),  hostname(7),
  138.  
  139.      _R_F_C_1_0_3_2, _R_F_C_1_0_3_3, _R_F_C_1_0_3_4, _R_F_C_1_0_3_5, _R_F_C_9_7_4
  140.  
  141.      _N_a_m_e _S_e_r_v_e_r _O_p_e_r_a_t_i_o_n_s _G_u_i_d_e _f_o_r _B_I_N_D.
  142.  
  143. HHIISSTTOORRYY
  144.      The rreess__qquueerryy function appeared in 4.3BSD.
  145.  
  146. 4.3 Berkeley Distribution        June 4, 1993                                3
  147.